Inside Macintosh: More Macintosh Toolbox
Previous | Chapter Top | Chapter Contents | Next |
The Component Manager maintains error state information for all currently active components. In general, your component returns error information in its function result; a nonzero function result indicates an error occurred, and a function result of 0 indicates the request was successful. However, some requests require that your component return other information as its function result. In these cases, your component can use the SetComponentInstanceError procedure to report its latest error state to the Component Manager. You can also use this procedure at any time during your component's execution to report an error
Although your component usually returns error information as its function result, your component can choose to use the SetComponentInstanceError procedure to pass error information to the Component Manager. The Component Manager uses this error information to set the current error value for the appropriate connection. Applications can then retrieve this error information by calling the GetComponentInstanceError function. The documentation for your component should specify how the component indicates errors.
PROCEDURE SetComponentInstanceError
(aComponentInstance: ComponentInstance; theError: OSErr);
The SetComponentInstanceError procedure sets the error associated with the specified component instance to the value specified by the parameter theError .
For a description of the GetComponentInstanceError function, see GetComponentInstanceError .